MagicLinks

interface MagicLinks

MagicLinks interface that encompasses authentication functions as well as other related functionality

Types

Link copied to clipboard
data class AuthParameters(val token: String, val sessionDurationMinutes: UInt = Constants.DEFAULT_SESSION_TIME_MINUTES)

Data class used for wrapping parameters used with MagicLinks authentication

Link copied to clipboard
interface EmailMagicLinks

Provides all possible ways to call EmailMagicLinks endpoints

Functions

Link copied to clipboard
abstract suspend fun authenticate(parameters: MagicLinks.AuthParameters): AuthResponse
abstract fun authenticate(parameters: MagicLinks.AuthParameters, callback: (AuthResponse) -> Unit)

Authenticate a user given a magic link. This endpoint verifies that the magic link token is valid, hasn't expired or been previously used.

Properties

Link copied to clipboard
abstract val email: MagicLinks.EmailMagicLinks

Public variable that exposes an instance of EmailMagicLinks